ISlave Interface

Represents an EtherCAT slave.

Inheritance hierarchy

System.Object
  System.ComponentModel.INotifyPropertyChanged
    IntervalZero.KINGSTAR.Base.Class.ISlave

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
public interface ISlave : INotifyPropertyChanged
Public Interface ISlave Inherits INotifyPropertyChanged

 

The ISlave interface exposes the following members.

Events

  Name Description
MailboxMessage Notifies the application that a device sent a mailbox message.

Methods

  Name Description
AoeReadCommand Reads data through ADS over EtherCAT (AoE).
AoeReadSdoObject Reads data from a slave using the ADS over EtherCAT (AoE) SDO method.
AoeReadWriteCommand Reads and writes data through ADS over EtherCAT (AoE) at the same time.
AoeWriteCommand Writes data through ADS over EtherCAT (AoE).
AoeWriteControlCommand Sends a command to the device through ADS over EtherCAT (AoE).
AoeWriteSdoObject Writes data to a slave using the ADS over EtherCAT (AoE) SDO method.
CoeReadSdoEntryDescription Reads the description of an entry of an object dictionary from an SDO object through CANopen over EtherCAT (CoE).
CoeReadSdoObject Reads the value of an SDO object through CANopen over EtherCAT (CoE).
CoeReadSdoObjectDescription Reads the description of an SDO object through CANopen over EtherCAT (CoE).
CoeReadSdoODList Reads the list of object indexes in a dictionary table using the CANopen over EtherCAT (CoE) SDO method.
CoeWriteSdoObject Writes the value of an SDO object through CANopen over EtherCAT (CoE).
EoeSetSlaveEoeIp Configures an EtherCAT slave's Ethernet over EtherCAT (EoE) network settings.
FoeReadFile Reads the servo drive's file and saves it on the local machine.
FoeWriteFile Reads a file on the local machine and writes it to the device.
ReadAlias Reads the alias address from an EtherCAT slave.
ReadAllEEprom Reads all data from a slave's EEPROM.
ReadEEprom Reads a double word from a slave's EEPROM.
ReadRegister Reads data from an EtherCAT slave's register.
ReloadEEprom Reloads a slave's EEPROM.
RequestState Requests an EtherCAT slave to go into the specified EtherCAT state.
ResetEsc Resets a slave's EtherCAT slave controller.
Restart Restarts the specified slave.
SoeReadSsc Uploads data from an EtherCAT slave to the EtherCAT master through SoE (Servo drive profile over EtherCAT).
SoeWriteSsc Downloads data from the EtherCAT master to a EtherCAT slave through SoE (Servo drive profile over EtherCAT).
UpdateConfiguration Updates the values of the module by reading them from the Subsystem.
VoeWrite Writes data into a VoE-enabled device through VoE (Vendor-specific protocol over EtherCAT).
WriteAlias Writes an alias address into an EtherCAT slave.
WriteAllEEprom Writes all data into a slave's EEPROM.
WriteEEprom Writes a double word into a slave's EEPROM.
WriteRegister Writes data into an EtherCAT slave's register.

Properties

  Name Description
Alias The alias address of a device, defined in the module EEPROM.
ExplicitId The explicit ID is an address on the EtherCAT network used to identify an EtherCAT slave.
Index The index of a device.
InputLength The length of the input data read from a device.
Name The name of a device.
OutputLength The length of the output data sent to a device.
ProductCode The product code of a device.
RevisionNumber The revision number of a device.
SerialNumber The serial number of a device.
State The EtherCAT state of a device.
VendorId The vendor ID of a device, given by the EtherCAT Technology Group to the manufacturer of the EtherCAT device.

See also

IntervalZero.KINGSTAR.Base.Class Namespace